home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr18 / cisrf111.zip / CISREF.DOC < prev    next >
Text File  |  1993-05-26  |  26KB  |  560 lines
  1.                            CISREF Version 1.11                  May 1993
  2.             Copyright 1991-1993 JNGoodale.  All Rights reserved.
  3.  
  4.  
  5.  
  6.  
  7.  
  8.               _______
  9.          ____|__     |                (R)     This program is shareware.
  10.       --|       |    |-------------------
  11.         |   ____|__  |  Association of        Please see Appendix B for
  12.         |  |       |_|  Shareware             a description of sharware.
  13.         |__|   o   |    Professionals         See REGISTER.DOC for
  14.       -----|   |   |---------------------     registration form.
  15.            |___|___|    MEMBER
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                               TABLE OF CONTENTS
  26.                               -----------------
  27.  
  28.            1.  General Description ..........................  1
  29.            2.  Requirements .................................  2
  30.            3.  Files ........................................  2
  31.            4.  Getting Started ..............................  3
  32.            5.  Operation ....................................  4
  33.            6.  Search Criteria ..............................  4
  34.            7.  Marking Files ................................  5
  35.            8.  End of Job ...................................  5
  36.  
  37.            Appendicies:
  38.  
  39.            A,  File Formats
  40.            B.  Shareware Definition/ASP Ombudsman
  41.            C.  Registration Information
  42.            
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.                                        i
  56.  
  57.                                                             Page  1
  58.                            GENERAL DESCRIPTION
  59.                            -------------------
  60.  
  61.       This program is a CompuServe forum library catalog viewing and
  62.       searching utility.  The catalog to be viewed must be on YOUR
  63.       computer - it is not intended for online viewing.  Online viewing
  64.       is very easy using the facilities available on CompuServe.
  65.  
  66.       With CISREF, you can browse thru all the catalog entries, or search
  67.       based on file name, keywords, etc.  You can "Mark" all files which
  68.       look interesting, and at the end get two listings:
  69.  
  70.                 1.  A synopsis of all "Marked" items including estimated               
  71.                     time and cost to download.  This is sorted by catalog
  72.                     name (same as forum name), library, and file name to
  73.                     be your organized list when ready to download - very
  74.                     useful if you will be downloading quite a few files.
  75.  
  76.                 2.  The full catalog entry information which appears on the
  77.                     screen when viewing.
  78.  
  79.       You can peruse these listings more carefully to make final decisions
  80.       on whether or not to download a file.
  81.       
  82.       The listings are also sent to a file, and you have the option to
  83.       print/not print either one or both.
  84.  
  85.       The first time you select a catalog for viewing, an index file is
  86.       created for that specific catalog to make searching faster.  This
  87.       index will be used in all subsequent searches and sessions until
  88.       a new downloaded catalog replaces the old one.  The index file will
  89.       have an extension of ".INX".
  90.  
  91.       *IMPORTANT NOTE* - The program uses dates and file sizes to check
  92.       the validity of the index file for the catalog.  Do not change the
  93.       file dates of the catalogs, or manipulate them in any way which
  94.       might change them.  DOS COPY command is safe to use - it does not
  95.       change file dates.
  96.                                                             Page  2
  97.  
  98.                                REQUIREMENTS
  99.                                ------------
  100.  
  101.  
  102.  
  103.                      IBM 100% Compatible
  104.                      DOS 3.0 or above
  105.                      Hard Drive
  106.                      256 K Available Memory (minimum)
  107.                            Lots more is much better
  108.                      Color or Monocrome monitor
  109.                      Printer - optional
  110.  
  111.       Note:  For monochrome monitors, start the program with:
  112.                 CISREF/m
  113.  
  114.  
  115.                                   FILES
  116.                                   -----
  117.  
  118.         Included in all versions:
  119.  
  120.         CISREF.COM - executable program
  121.         CISREF.DOC - this file
  122.         CISREF.HLP - instructions used during program execution
  123.         README.TXT - short documentation file
  124.         WHATS.NEW - update history
  125.  
  126.         Included in Shareware version only:
  127.  
  128.         FILE_ID.DIZ - quick description
  129.         REGISTER.DOC - registration form
  130.         SAMP1.CAT - sample input file you may use to try CISREF
  131.         SAMP2.CAT - a second input file to try
  132.  
  133.         Created
  134.  
  135.         CISREF.CNF - a short configuration file
  136.         SAMP1.INX - index file for SAMP1.CAT (Shareware version)
  137.         SAMP2.INX - index file for SAMP2.CAT (Shareware version)
  138.         FORUMARK.TXT - header info for "marked" files
  139.         FORUMARK.DES - full description info for "marked" files
  140.         FORUMARK.CUR - not used by CISREF, but available for interfacing
  141.                         to your own programs.  Contains basic data on
  142.                         "marked" files.
  143.  
  144.  
  145.  
  146.                                                             Page  3
  147.  
  148.                               GETTING STARTED
  149.                               ---------------
  150.  
  151.       This catalog viewer is specifically for the LONG description
  152.       catalogs, in the format current as of Jan. 1992, available in
  153.       the CompuServe IBMNET.  They are in library 0 of each IBMNET
  154.       forum and are named as follows:
  155.  
  156.                   Forum     File Name      Unzips to
  157.  
  158.                   IBMAPP    IBMAPP.ZIP     IBMAPP.CAT
  159.                   IBMBBS    IBMBBS.ZIP     IBMBBS.CAT
  160.                   IBMCOM    IBMCOM.ZIP     IBMCOM.CAT
  161.                   IBMHW     IBMHW.ZIP      IBMHW.CAT
  162.                   IBMNEW    IBMNEW.ZIP     IBMNEW.CAT
  163.                   IBMPRO    IBMPRO.ZIP     IBMPRO.CAT
  164.                   IBMSYS    IBMSYS.ZIP     IBMSYS.CAT
  165.  
  166.       If other forums have catalogs with the same format, CISREF will
  167.       work for them as well.
  168.  
  169.       One or more of these files must be downloaded and made available
  170.       to CISREF before you can effectively use the program for anything
  171.       except generating the message "No *.CAT files found on this directory".
  172.  
  173.       In order to retrieve a list of catalogs for viewing, CISREF expects the
  174.       catalog files to have an extension of ".CAT" and be located in the
  175.       current directory. There is a limit of 20 Catalogs per directory.
  176.  
  177.       The program itself can be located in the current directory, or any
  178.       directory specified in your PATH.
  179.                                                                        
  180.       Once you are in the directory with the *.CAT files, start the program
  181.       with:
  182.                      CISREF
  183.                        or
  184.                      CISREF/m   for a monochrome monitor
  185.  
  186.       Limitations:
  187.  
  188.                 20 Catalog files per directory (that's a lot of stuff!)
  189.                 10 Character FileNames are assumed within the Catalog
  190.                    File descriptions.  This is currently the case on the
  191.                    IBMNET forums.  That is, all file names are limited to
  192.                    a max of "xxxxxx.xxx" in the libraries.
  193.  
  194.       
  195.                                                             Page  4
  196.  
  197.                                  OPERATION
  198.                                  ---------
  199.  
  200.       The program is directed with menu selection and various keys.
  201.       The applicable key definitions are displayed on the screen during
  202.       program execution for reference.
  203.  
  204.       The Function Keys (and others) generally have the following effect:
  205.  
  206.            [F1] - Display Instructions
  207.            [F2] - Mark this item (see "Marking", below)
  208.            [F3] - Continue with the same search criteria
  209.            [F8] - Go to Top Menu
  210.            [F9] - Exit the program
  211.            [ESC] - Back out of current activity/Interrupt search
  212.            [HOME] - Restart same search at beginning of file
  213.            [ENTER] - Select high-lighted menu item/Page forward
  214.  
  215.       One note on [F9] and [ESC] -  The [F9] key will go immediately to
  216.       the program exit.  [ESC] will keep backing up, until finally you
  217.       back out the door to the program exit. 
  218.  
  219.                                SEARCH CRITERIA 
  220.                                ---------------
  221.  
  222.       The search criteria will find a hit on any occurrance of the search
  223.       string you enter, within the field being searched.  Therefore, if
  224.       your search field is "File Name", and your search string is "ZIP",
  225.       all of the following file names would be a "hit":
  226.  
  227.                                CISREF.ZIP
  228.                                PKZIP.ARC
  229.                                UNZIP.EXE
  230.                                ZIP210.EXE
  231.  
  232.       If your search string is ".ZIP", then only CISREF.ZIP would be found.
  233.       If you enter no search string, all records are displayed in turn.
  234.  
  235.       If there is room in memory, the program uses an index file for the
  236.       search.  If the index has not yet been created, it creates one.  This
  237.       greatly speeds up searching.  If there is not room in memory, the
  238.       search is sequential, and much slower. 
  239.  
  240.       The index file (*.INX) is saved to disk to be available for future
  241.       sessions.  When you download a new Catalog description file to replace
  242.       the old one, the program detects that this is a new catalog file and
  243.       will generate a new associated index file.
  244.                                                             Page  5
  245.  
  246.                                 MARKING FILES
  247.                                 -------------
  248.  
  249.       After finding something that looks interesting, you can "mark" the
  250.       item for later viewing or printing.  [F2] will mark it, and at the end
  251.       of the program, all these items are gathered together into three files,
  252.       described next.  Any number of catalogs can be searched during one
  253.       execution of the program.  All marked items from every catalog visited
  254.       during the session will be saved.
  255.  
  256.       If any items are marked, three files will be issued:
  257.  
  258.            FORUMARK.TXT - a text (ASCII) file of header information.
  259.            FORUMARK.DES - a text file of the full description of the
  260.                           item marked.
  261.            FORUMARK.CUR - a one record file containing an array of
  262.                           all the header information for use by other
  263.                           programs.  See the documentation for a
  264.                           description of the layout.
  265.  
  266.       If no items are marked, only a zero length FORUMARK.DES file is issued.
  267.  
  268.       Time and cost estimates for downloading are based on values in the
  269.       file CISREF.CNF, which is initialized to use 2400 Baud, 12.80/hour.
  270.       One minute is added to all time estimates for overhead.  You can
  271.       change these by selecting the "Change Rates" option from the Main Menu.
  272.  
  273.  
  274.                                 END OF THE JOB 
  275.                                 --------------
  276.  
  277.       Before exiting, CISREF will give you the option to print the first
  278.       two files if any items were marked.  The files will remain intact
  279.       but will be overwritten next run, whether or not you elect to print.
  280.  
  281.       See Appendix A for samples of expected input and the format of all
  282.       files.
  283.  
  284.  
  285.       _________________________________________________________________
  286.         If you have problems or questions, contact the author:
  287.                            JN Goodale
  288.                            CIS ID 71116,302
  289.                            Phone   (704)-537-0329 (Your nickel!)
  290.       _________________________________________________________________
  291.  
  292.                                                             App A-1
  293.                                                             
  294.                       FILE FORMATS and OTHER STUFF
  295.                       ----------------------------
  296.  
  297.  
  298.       INPUT FORMAT
  299.       ------------
  300.  
  301.       Sample taken from IBMCOM.CAT   (right side is truncated to allow
  302.                                       for margins)
  303.  
  304.       The *.CAT files look like this, and MUST be in this format:
  305.       ______________________________________________________________________
  306.       [71141,1224]    Lib: 1
  307.       ACL313.EXE/Bin  Bytes:  42715, Count:  793, 07-Feb-91
  308.  
  309.         Title   : AUTOSIG Accounting Module, ACLS, Version 3.13
  310.         Keywords: ATO AUTOSIG ACLS ACCOUNTING MODULE RATES
  311.  
  312.         AUTOSIG Accounting Module, ACLS, Version 3.13.  Update includes supp
  313.         for CompuServe's new 9600 baud service, including a new RATES.ATO fi
  314.         Place in your directory with ATO, and type "ACLS", or select F9 from
  315.         main menu. Self-extracting archive.  Documentation is file ATOADV.EX
  316.  
  317.       [70327,135]     Lib: 1
  318.       ATO.PIF/Bin     Bytes:    545, Count: 1352, 21-Jun-90
  319.  
  320.         Title   : PIF file for Autosig
  321.         Keywords: WINDOWS AUTOSIG ATO PIF
  322.  
  323.         Windows 3.0 PIF file for Autosig.  Created for 386eh mode, but shoul
  324.         for all.  Corrected to allow background operation, including 
  325.         upload/download.  Use the PIF editor to set the path and command lin
  326.         options to match your configuration.
  327.  
  328.       [76703,750]     Lib: 1
  329.       ATO68A.EXE/Bin  Bytes: 131323, Count: 1410, 11-Aug-91
  330.  
  331.         Title   : AUTOSIG Ver. 6.8a; CIS communications program
  332.         Keywords: ATO AUTOSIG FORUM SIG AUTOMATIC MESSAGES FILES LIBRARIES 
  333.                   LIBRARY
  334.  
  335.         AUTOSIG version 6.8A executable program file. See ATODOC.EXE for 
  336.         main documentation, and ATOADV.EXE for documentation on advanced scr
  337.         PPN database functions. Please read ATO68A.REQ before downloading th
  338.         file. See WHATS.NEW for a summary of changes since prior version. Se
  339.         extracting file. Run from DOS prompt to extract. Free software.
  340.       ______________________________________________________________________
  341.       
  342.                                                             App A-2
  343.       OUTPUT FORMAT
  344.       -------------
  345.  
  346.       FORUMARK.TXT is an ASCII text file that looks like this:
  347.       ______________________________________________________________________
  348.  
  349.              Forum Catalog Libraries: Marked  03-16-1992/16:43:31      Page  1    
  350.                                                                              
  351.     Forum  Lib File       UserID        Date       Bytes  Acc   Time   Cost Seq
  352.                                                                              
  353.    IBMAPP    1 ADDCOL.COM [74025,514]   10-Jun-85  12544  232      1     22   1
  354.    IBMAPP    1 ADDLF.ARC  [73300,517]   21-Dec-87   8260  145      1     22   2
  355.    IBMAPP    1 AMAC41.ZIP [76370,1073]  26-Aug-91 314765   23     24    528   3
  356.    IBMCOM    1 ATO68A.EXE [76703,750]   11-Aug-91 131323 1410     10    220   4
  357.    IBMCOM    1 ATOADV.EXE [70007,1212]  28-Mar-90  19760 3675      2     44   5
  358.    IBMSYS    1 BOOT13.ZIP [74365,1716]  18-Aug-90   3234  557      1     22   7
  359.    IBMSYS    9 DSKNDX.ZIP [71116,302]   29-Jul-91  34975   63      3     66   6
  360.                                                                             
  361.     Total   7                                                     42    924    
  362.       ----------------------------------------------------------------------
  363.  
  364.       FORUMARK.DES is an ASCII text file that looks like this:
  365.       ______________________________________________________________________
  366.  
  367.              Forum Catalog Libraries: Marked  03-16-1992/16:43:31      Page  1       
  368.                                                                                 
  369.       [74025,514]                                                         [ 1]  
  370.       ADDCOL.COM/Bin  Bytes:  12544, Count:  232, 10-Jun-85                          
  371.                                                                                 
  372.         Title   :                                                                    
  373.         Keywords: ADD COLUMN PROGRAM                                                 
  374.         This program will concatenate two files in a line by line fashion.  
  375.         the uses could be to add columns of text from two files to make a            
  376.         single file containing the two columns.  You could add a column of 
  377.         front of a second file to change the margin.  Read ADDCOL.DOC for mo
  378.         information.                                                                 
  379.                                                                                 
  380.       [73300,517]                                                         [ 2]  
  381.       ADDLF.ARC/Bin   Bytes:   8260, Count:  145, 21-Dec-87                          
  382.                                                                                 
  383.         Title   : Convert text file CRs to LF/CR                                     
  384.         Keywords: ASCII TEXT CR LF CONVERSION FILE LF-CR                             
  385.         This program converts ASCII text files with only CRs to those with           
  386.         LF-CRs. It is written in Microsoft C and runs very quickly.  Public 
  387.         Uploaded by the author.                                                      
  388.                                                                                 
  389.                                                                                 
  390.                           -------------------------                                                                          
  391.                                 
  392.                                 etc. .............
  393.  
  394.       ----------------------------------------------------------------------
  395.       
  396.                                                             App A-3
  397.  
  398.       FORUMARK.CUR is a one record array of all the items in FORUMARK.TXT.
  399.                    Each element of the array has the following format:
  400.       ______________________________________________________________________
  401.  
  402.               Position    Data Type      Description
  403.               --------    ---------      -----------
  404.                1 - 8      ASCII          Forum ID (Catalog base name)
  405.                9 - 10       "            Library number
  406.               11 - 20       "            File Name
  407.               21 - 22       "            Reserved
  408.               23 - 35       "            CIS User ID
  409.               36 - 44       "            Date file was uploaded
  410.               45 - 50       "            Reserved for download date
  411.               51 - 52     Integer        Mark Sequence
  412.               53 - 56     Long integer   File Size
  413.               57 - 58     Integer        Number of accesses
  414.               59 - 60     Integer        Estimated minutes to download
  415.               61 - 64     Long integer   Estimated cost to download
  416.       ----------------------------------------------------------------------
  417.  
  418.       *.INX is an index file used to speed searching. 
  419.  
  420.       It is a one record array, containing pointers to header information
  421.            in the associated *.CAT file.
  422.       Each element of the array has the following format:
  423.       ______________________________________________________________________
  424.  
  425.       Field   Position    Data Type      Description
  426.       -----   --------    ---------      -----------
  427.         1      1 - 13     ASCII          CIS User ID
  428.         2     14 - 23       "            File Name
  429.         3     24 - 25       "            Reserved
  430.         4     26 - 27       "            Library number
  431.         5     28 - 94       "            First line of Keywords
  432.         6     95 - 96     Integer        File age in Weeks  
  433.         7     97 - 100    Long integer   File size
  434.         8    101 - 102    Integer        Number of File accesses
  435.         9    103 - 104    Integer        Length of Catalog File description
  436.        10    105 - 108    Long integer   Start position in Catalog File
  437.  
  438.       The first array element contains information on the associated *.CAT
  439.       file and is used to validate the use of the *.INX file.
  440.  
  441.       Field     Contents
  442.       -----     --------
  443.         1       Date/Time stamp of the *.CAT file creation (YYMMDDHHMMSS)
  444.         9       Number of items in the array
  445.        10       File size of the associated *.CAT file
  446.  
  447.         This element is used to check the validity of the associated *.INX
  448.         and *.CAT files, and to reserve room in memory for the *.INX file.
  449.         If the *.INX and *.CAT files don't match, a new *.INX is created.
  450.  
  451.                                                             App A-4
  452.  
  453.         When the *.INX is created, the program tells you how many elements
  454.         can be stored in memory (Max Entries) for THAT PARTICULAR machine 
  455.         and boot configuration.
  456.  
  457.         600K available memory will hold an array of about 5,000 elements,
  458.         which handles the IBMSYS.CAT file (1,800,000 + bytes).
  459.  
  460.         256K available memory will hold an array of about 1,000 elements.
  461.  
  462.         If there isn't room to create the index (or read it in), the
  463.         program does a "sequential" search, which is much slower.  It works,
  464.         but if the item you're looking for doesn't find a match till deep
  465.         into the file, it takes much longer than an "indexed" search.
  466.  
  467.         CISREF.CNF
  468.         ----------
  469.         Contains baud rates and costs for estimating download costs.  Can
  470.         be updated within the program with the "Change Rates" option.  The
  471.         file contains one record which is a five element array.  The format
  472.         of each element is:
  473.  
  474.         Field   Position    Data Type      Description
  475.         -----   --------    ---------      -----------
  476.           1          1      ASCII          Letter ID
  477.           2      2 - 12       "            Label
  478.           3     13 - 16     Long integer   Bytes/Min transfer rate
  479.           4     17 - 20     Long integer   CIS Hourly charge
  480.  
  481.         These elements are initialized as follows:
  482.  
  483.         Element #  ID       Label       Bytes/Min    CIS $/Hour
  484.         ---------  --       ---------   ---------    ----------
  485.             1       A       Baud=300         1695        630
  486.             2       B       Baud=1200        6780       1280
  487.             3       C       Baud=2400       13560       1280 - default
  488.             4       D       Baud=9600       54240       2280
  489.             5       E       User Define      1695          0
  490.  
  491.                                                             App B
  492.  
  493.         SHAREWARE CONCEPT
  494.         -----------------
  495.  
  496.         Shareware distribution gives users a chance to try software
  497.         before buying it.  If you try a Shareware program and continue
  498.         using it, you are expected to register.
  499.  
  500.         Shareware is a distribution method, not a type of software.  You
  501.         should find software that suits your needs and pocketbook, whether
  502.         it's commercial or Shareware.  The Shareware system makes fitting
  503.         your needs easier, because you can try before you buy.  And because
  504.         the overhead is low, prices are low also.  Shareware has the
  505.         ultimate money-back guarantee -- if you don't use the product,
  506.         you don't pay for it!
  507.  
  508.         OMBUDSMAN
  509.         ---------
  510.  
  511.  
  512.                Association Of Shareware Professionals Ombudsman
  513.  
  514.         This program is produced by a member of the Association of
  515.         Shareware Professionals (ASP).  ASP wants to make sure that the
  516.         shareware principle works for you.  If you are unable to resolve a
  517.         shareware-related problem with an ASP member by contacting the
  518.         member directly, ASP may be able to help.  The ASP Ombudsman can
  519.         help you resolve a dispute or problem with an ASP member, but does
  520.         not provide technical support for members' products.  Please write
  521.         to the ASP Ombudsman at P.O. Box 5786, Bellevue, WA 98006 or send
  522.         a Compuserve message via easyplex to ASP Ombudsman 70007,3536.
  523.                                                             App C
  524.  
  525.         REGISTRATION INFORMATION
  526.         ------------------------
  527.         You can register within the program by selecting the 
  528.         "REGISTER" option, or you can print REGISTER.DOC to 
  529.         fill out manually.
  530.  
  531.         When you register CISREF you will recieve the following:
  532.  
  533.                 A copy of the latest version of the Registered program.
  534.                 Notification of upgrades for 12 months.
  535.                 Upgrades (if requested) for only the cost of
  536.                         shipping and handling - around $3.00
  537.                 Free support by mail, phone (your nickle), or CIS
  538.                         E-Mail for six months.
  539.                 Your choice of the complete IBMNET catalogs, up to as
  540.                         many as will fit on the diskette you select.
  541.                         The catalog(s) will be no more than 90 days
  542.                         old as of the day I send your disk.  See list
  543.                         on the Registration Form, App D.
  544.  
  545.         If you find this program useful, please register and support the
  546.         Shareware industry.
  547.  
  548.         Feel free to give copies to anyone, but assure that ALL distribution
  549.         files are included.
  550.  
  551.  
  552.  
  553.         Registration is $15, plus $1 for 720K or 1.2M diskette, or
  554.         $2 for 1.4M diskette.  Send registration to:
  555.  
  556.                 JN Goodale
  557.                 7826 Littlejohn Court
  558.                 Charlotte, NC 28227
  559.  
  560.